.TH LCTL-NODEMAP_ADD_IDMAP 8 2024-08-14 Lustre "Lustre Configuration Utilities"
.SH NAME
lctl-nodemap_add_idmap \- define ID mappings for a nodemap
.SH SYNOPSIS
.SY "lctl nodemap_add_idmap"
or
.SY "lctl nodemap add_idmap"
.B --name
.I NODEMAP_NAME
.BR --idtype " {" uid | gid | projid }
.B --idmap
.IR CLIENTID [- CLIENTID_END ]: FSID [- FSID_END ]
.YS
.SH DESCRIPTION
.B nodemap_add_idmap
adds an identity mapping to a nodemap. Clients that are members of the given
nodemap will have the identities of their users mapped accordingly.
.PP
When offsets are defined on the nodemap, any explicit identity mapping should
map to an
.I FSID
in the offset range [ 0, offset_limit-1 ], otherwise the mapped ID would escape
offsetting.
.SH OPTIONS
.TP
.BI --name " NODEMAP_NAME"
The name of the nodemap that this idmap should be added to.
.TP
.BR --idtype " {" uid | gid | projid }
Either "uid" or "gid" or "projid" depending on if it is a user ID or group
ID or project ID that is to be mapped.
.TP
.BI --idmap " CLIENTID\fR[" - CLIENTID_END\fR] : FSID\fR[ - FSID_END\fR]
The identity to map, and what it should be mapped to.
The first number is the ID of the user or group as it is on the client,
and the second number is the ID that it should map to on the Lustre filesystem.
.SH EXAMPLES
.EX
.B # lctl nodemap_add_idmap --name remotesite --idtype uid --idmap 2001:1001
.B # lctl nodemap_add_idmap --name remotesite --idtype gid --idmap 2002:1002
.B # lctl nodemap_add_idmap --name remotesite --idtype projid --idmap 33:1
.B # lctl nodemap_add_idmap --name othersite --idtype uid --idmap 0-999:9000

.EE
.SH AVAILABILITY
.B lctl nodemap_add_idmap
is part of the
.BR lustre (7)
filesystem package since release 2.6.0
.\" Added in commit v2_5_56_0-14-g294b0efc31
.SH SEE ALSO
.BR lustre (7),
.BR lctl-nodemap-activate (8),
.BR lctl-nodemap-add (8),
.BR lctl-nodemap-add-offset (8),
.BR lctl-nodemap-add-range (8),
.BR lctl-nodemap-del (8),
.BR lctl-nodemap-del-idmap (8),
.BR lctl-nodemap-del-offset (8),
.BR lctl-nodemap-del-range (8),
.BR lctl-nodemap-modify (8)
